<HTML>
<BODY BGCOLOR="white">
<PRE>
<FONT color="green">001</FONT>    /*<a name="line.1"></a>
<FONT color="green">002</FONT>     * Licensed to the Apache Software Foundation (ASF) under one or more<a name="line.2"></a>
<FONT color="green">003</FONT>     * contributor license agreements.  See the NOTICE file distributed with<a name="line.3"></a>
<FONT color="green">004</FONT>     * this work for additional information regarding copyright ownership.<a name="line.4"></a>
<FONT color="green">005</FONT>     * The ASF licenses this file to You under the Apache License, Version 2.0<a name="line.5"></a>
<FONT color="green">006</FONT>     * (the "License"); you may not use this file except in compliance with<a name="line.6"></a>
<FONT color="green">007</FONT>     * the License.  You may obtain a copy of the License at<a name="line.7"></a>
<FONT color="green">008</FONT>     *<a name="line.8"></a>
<FONT color="green">009</FONT>     *      http://www.apache.org/licenses/LICENSE-2.0<a name="line.9"></a>
<FONT color="green">010</FONT>     *<a name="line.10"></a>
<FONT color="green">011</FONT>     * Unless required by applicable law or agreed to in writing, software<a name="line.11"></a>
<FONT color="green">012</FONT>     * distributed under the License is distributed on an "AS IS" BASIS,<a name="line.12"></a>
<FONT color="green">013</FONT>     * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.<a name="line.13"></a>
<FONT color="green">014</FONT>     * See the License for the specific language governing permissions and<a name="line.14"></a>
<FONT color="green">015</FONT>     * limitations under the License.<a name="line.15"></a>
<FONT color="green">016</FONT>     */<a name="line.16"></a>
<FONT color="green">017</FONT>    package org.apache.commons.math3.linear;<a name="line.17"></a>
<FONT color="green">018</FONT>    <a name="line.18"></a>
<FONT color="green">019</FONT>    import org.apache.commons.math3.util.IterationEvent;<a name="line.19"></a>
<FONT color="green">020</FONT>    import org.apache.commons.math3.exception.MathUnsupportedOperationException;<a name="line.20"></a>
<FONT color="green">021</FONT>    <a name="line.21"></a>
<FONT color="green">022</FONT>    /**<a name="line.22"></a>
<FONT color="green">023</FONT>     * This is the base class for all events occuring during the iterations of a<a name="line.23"></a>
<FONT color="green">024</FONT>     * {@link IterativeLinearSolver}.<a name="line.24"></a>
<FONT color="green">025</FONT>     *<a name="line.25"></a>
<FONT color="green">026</FONT>     * @version $Id: IterativeLinearSolverEvent.java 1416643 2012-12-03 19:37:14Z tn $<a name="line.26"></a>
<FONT color="green">027</FONT>     * @since 3.0<a name="line.27"></a>
<FONT color="green">028</FONT>     */<a name="line.28"></a>
<FONT color="green">029</FONT>    public abstract class IterativeLinearSolverEvent<a name="line.29"></a>
<FONT color="green">030</FONT>        extends IterationEvent {<a name="line.30"></a>
<FONT color="green">031</FONT>        /** Serialization identifier. */<a name="line.31"></a>
<FONT color="green">032</FONT>        private static final long serialVersionUID = 20120129L;<a name="line.32"></a>
<FONT color="green">033</FONT>    <a name="line.33"></a>
<FONT color="green">034</FONT>        /**<a name="line.34"></a>
<FONT color="green">035</FONT>         * Creates a new instance of this class.<a name="line.35"></a>
<FONT color="green">036</FONT>         *<a name="line.36"></a>
<FONT color="green">037</FONT>         * @param source the iterative algorithm on which the event initially<a name="line.37"></a>
<FONT color="green">038</FONT>         * occurred<a name="line.38"></a>
<FONT color="green">039</FONT>         * @param iterations the number of iterations performed at the time<a name="line.39"></a>
<FONT color="green">040</FONT>         * {@code this} event is created<a name="line.40"></a>
<FONT color="green">041</FONT>         */<a name="line.41"></a>
<FONT color="green">042</FONT>        public IterativeLinearSolverEvent(final Object source, final int iterations) {<a name="line.42"></a>
<FONT color="green">043</FONT>            super(source, iterations);<a name="line.43"></a>
<FONT color="green">044</FONT>        }<a name="line.44"></a>
<FONT color="green">045</FONT>    <a name="line.45"></a>
<FONT color="green">046</FONT>        /**<a name="line.46"></a>
<FONT color="green">047</FONT>         * Returns the current right-hand side of the linear system to be solved.<a name="line.47"></a>
<FONT color="green">048</FONT>         * This method should return an unmodifiable view, or a deep copy of the<a name="line.48"></a>
<FONT color="green">049</FONT>         * actual right-hand side vector, in order not to compromise subsequent<a name="line.49"></a>
<FONT color="green">050</FONT>         * iterations of the source {@link IterativeLinearSolver}.<a name="line.50"></a>
<FONT color="green">051</FONT>         *<a name="line.51"></a>
<FONT color="green">052</FONT>         * @return the right-hand side vector, b<a name="line.52"></a>
<FONT color="green">053</FONT>         */<a name="line.53"></a>
<FONT color="green">054</FONT>        public abstract RealVector getRightHandSideVector();<a name="line.54"></a>
<FONT color="green">055</FONT>    <a name="line.55"></a>
<FONT color="green">056</FONT>        /**<a name="line.56"></a>
<FONT color="green">057</FONT>         * Returns the norm of the residual. The returned value is not required to<a name="line.57"></a>
<FONT color="green">058</FONT>         * be &lt;em&gt;exact&lt;/em&gt;. Instead, the norm of the so-called &lt;em&gt;updated&lt;/em&gt;<a name="line.58"></a>
<FONT color="green">059</FONT>         * residual (if available) should be returned. For example, the<a name="line.59"></a>
<FONT color="green">060</FONT>         * {@link ConjugateGradient conjugate gradient} method computes a sequence<a name="line.60"></a>
<FONT color="green">061</FONT>         * of residuals, the norm of which is cheap to compute. However, due to<a name="line.61"></a>
<FONT color="green">062</FONT>         * accumulation of round-off errors, this residual might differ from the<a name="line.62"></a>
<FONT color="green">063</FONT>         * true residual after some iterations. See e.g. A. Greenbaum and<a name="line.63"></a>
<FONT color="green">064</FONT>         * Z. Strakos, &lt;em&gt;Predicting the Behavior of Finite Precision Lanzos and<a name="line.64"></a>
<FONT color="green">065</FONT>         * Conjugate Gradient Computations&lt;/em&gt;, Technical Report 538, Department of<a name="line.65"></a>
<FONT color="green">066</FONT>         * Computer Science, New York University, 1991 (available<a name="line.66"></a>
<FONT color="green">067</FONT>         * &lt;a href="http://www.archive.org/details/predictingbehavi00gree"&gt;here&lt;/a&gt;).<a name="line.67"></a>
<FONT color="green">068</FONT>         *<a name="line.68"></a>
<FONT color="green">069</FONT>         * @return the norm of the residual, ||r||<a name="line.69"></a>
<FONT color="green">070</FONT>         */<a name="line.70"></a>
<FONT color="green">071</FONT>        public abstract double getNormOfResidual();<a name="line.71"></a>
<FONT color="green">072</FONT>    <a name="line.72"></a>
<FONT color="green">073</FONT>        /**<a name="line.73"></a>
<FONT color="green">074</FONT>         * &lt;p&gt;<a name="line.74"></a>
<FONT color="green">075</FONT>         * Returns the residual. This is an optional operation, as all iterative<a name="line.75"></a>
<FONT color="green">076</FONT>         * linear solvers do not provide cheap estimate of the updated residual<a name="line.76"></a>
<FONT color="green">077</FONT>         * vector, in which case<a name="line.77"></a>
<FONT color="green">078</FONT>         * &lt;/p&gt;<a name="line.78"></a>
<FONT color="green">079</FONT>         * &lt;ul&gt;<a name="line.79"></a>
<FONT color="green">080</FONT>         * &lt;li&gt;this method should throw a<a name="line.80"></a>
<FONT color="green">081</FONT>         * {@link MathUnsupportedOperationException},&lt;/li&gt;<a name="line.81"></a>
<FONT color="green">082</FONT>         * &lt;li&gt;{@link #providesResidual()} returns {@code false}.&lt;/li&gt;<a name="line.82"></a>
<FONT color="green">083</FONT>         * &lt;/ul&gt;<a name="line.83"></a>
<FONT color="green">084</FONT>         * &lt;p&gt;<a name="line.84"></a>
<FONT color="green">085</FONT>         * The default implementation throws a<a name="line.85"></a>
<FONT color="green">086</FONT>         * {@link MathUnsupportedOperationException}. If this method is overriden,<a name="line.86"></a>
<FONT color="green">087</FONT>         * then {@link #providesResidual()} should be overriden as well.<a name="line.87"></a>
<FONT color="green">088</FONT>         * &lt;/p&gt;<a name="line.88"></a>
<FONT color="green">089</FONT>         *<a name="line.89"></a>
<FONT color="green">090</FONT>         * @return the updated residual, r<a name="line.90"></a>
<FONT color="green">091</FONT>         */<a name="line.91"></a>
<FONT color="green">092</FONT>        public RealVector getResidual() {<a name="line.92"></a>
<FONT color="green">093</FONT>            throw new MathUnsupportedOperationException();<a name="line.93"></a>
<FONT color="green">094</FONT>        }<a name="line.94"></a>
<FONT color="green">095</FONT>    <a name="line.95"></a>
<FONT color="green">096</FONT>        /**<a name="line.96"></a>
<FONT color="green">097</FONT>         * Returns the current estimate of the solution to the linear system to be<a name="line.97"></a>
<FONT color="green">098</FONT>         * solved. This method should return an unmodifiable view, or a deep copy of<a name="line.98"></a>
<FONT color="green">099</FONT>         * the actual current solution, in order not to compromise subsequent<a name="line.99"></a>
<FONT color="green">100</FONT>         * iterations of the source {@link IterativeLinearSolver}.<a name="line.100"></a>
<FONT color="green">101</FONT>         *<a name="line.101"></a>
<FONT color="green">102</FONT>         * @return the solution, x<a name="line.102"></a>
<FONT color="green">103</FONT>         */<a name="line.103"></a>
<FONT color="green">104</FONT>        public abstract RealVector getSolution();<a name="line.104"></a>
<FONT color="green">105</FONT>    <a name="line.105"></a>
<FONT color="green">106</FONT>        /**<a name="line.106"></a>
<FONT color="green">107</FONT>         * Returns {@code true} if {@link #getResidual()} is supported. The default<a name="line.107"></a>
<FONT color="green">108</FONT>         * implementation returns {@code false}.<a name="line.108"></a>
<FONT color="green">109</FONT>         *<a name="line.109"></a>
<FONT color="green">110</FONT>         * @return {@code false} if {@link #getResidual()} throws a<a name="line.110"></a>
<FONT color="green">111</FONT>         * {@link MathUnsupportedOperationException}<a name="line.111"></a>
<FONT color="green">112</FONT>         */<a name="line.112"></a>
<FONT color="green">113</FONT>        public boolean providesResidual() {<a name="line.113"></a>
<FONT color="green">114</FONT>            return false;<a name="line.114"></a>
<FONT color="green">115</FONT>        }<a name="line.115"></a>
<FONT color="green">116</FONT>    }<a name="line.116"></a>




























































</PRE>
</BODY>
</HTML>
